@casual-simulation/crypto-browser

Crypto Browser

Installation

npm install @casual-simulation/crypto-browser

Usage

// ES6-style imports are required.
// If you are running in an environment that does not support ES Modules,
// then use Webpack or Babel to transpile to the format you want. (like CommonJS)
import { BrowserSigningCryptoImpl } from '@casual-simulation/crypto-browser';

// Async is optional. Every method returns a promise.
async function demo() {
    // Currently ECDSA-SHA256-NISTP256 is the only supported
    // algorithm.
    let algorithm = 'ECDSA-SHA256-NISTP256';
    let crypto = new BrowserSigningCryptoImpl(algorithm);

    console.log('Crypto Supported: ', crypto.supported());

    // Generate a public-private key pair.
    let [publicKey, privateKey] = await crypto.generateKeyPair();

    // You can export the public and private keys to
    // share them with other devices. (But really only share the public key)
    let exportedPubKey = await crypto.exportKey(publicKey);
    let exportedPrivateKey = await crypto.exportKey(privateKey);

    // You can import keys that were exported using exportKey()
    // via the importPrivateKey() and importPublicKey() methods.

    console.log('Public Key: ', exportedPubKey);
    console.log('Private Key: ', exportedPrivateKey);
    // TODO: Save/share keys

    // Any ArrayBuffer will work
    let data = new Int32Array(100);

    // If you're using webpack, enable the Buffer polyfil.
    // This will let you convert strings to ArrayBuffer compatible
    // objects using Buffer.from(str).
    // Read More: https://webpack.js.org/configuration/node/

    // Fill with pseudo-random data.
    for (let i = 0; i < data.length; i++) {
        data[i] = Math.floor(Math.random() * 100);
    }

    // Sign the data
    let signature = crypto.sign(privateKey, data);

    // TODO: Send or store the signature and data

    // Verify the signature.
    // Note that the data must be provided as well.
    // This is because the signature does not store the data
    // in a usable format.
    let valid = crypto.verify(publicKey, signature, data);
    console.log('Valid: ', valid);
}

demo();

Changelog

V2.0.22

Date: 1/3/2022

:boom: Breaking Changes

• Removed the following functions:
  • os.publishRecord()
  • os.getRecords()
  • os.destroyRecord()
  • byAuthID()
  • withAuthToken()
  • byAddress()
  • byPrefix()

:rocket: Improvements

• Implemented the next version of records.
  • This version replaces the old API (os.publishRecord()) and introduces a new paradigm.
  • The first major change is that records now represent multiple pieces of data.
  • os.getPublicRecordKey(recordName) has been added as a way to retrieve a key that can be used to write data and files to a public record.
  • os.recordData(recordKey, address, data) can be used to store a piece of data at an address inside a record. This data can later be retrieved with os.getData(recordKeyOrName, address).
  • os.getData(recordKeyOrName, address) can be used to retrieve data that was stored in a record.
  • os.recordFile(recordKey, data, options?) can be used to store a file inside a record. Files can be any size and can be accessed via webhook() or os.getFile(url).
  • os.getFile(urlOrRecordFileResult) can be used to easily retrieve a file.
  • os.isRecordKey(value) is useful for determining if a value represents a record key.
  • See the documentation for more information.
• Updated Material Icons to the latest publicly available version.